Skip to content

feat: Update docstrings and tests, introduce orcid argument #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Jan 25, 2025
Merged

feat: Update docstrings and tests, introduce orcid argument #154

merged 6 commits into from
Jan 25, 2025

Conversation

@yucongalicechen
Copy link
Collaborator

@yucongalicechen yucongalicechen commented Jan 23, 2025 •
edited
Loading

closes #150, closes #152

  • Update docstrings and tests
  • Add orcid argument in the main module and load_user_info

yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
@codecov
Copy link

codecov bot commented Jan 23, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.21%. Comparing base (08032ab) to head (84aa727).
Report is 7 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #154      +/-   ##
==========================================
- Coverage   99.27%   99.21%   -0.07%     
==========================================
  Files           5        5              
  Lines         275      254      -21     
==========================================
- Hits          273      252      -21     
  Misses          2        2
Files with missing lines Coverage Δ
tests/test_functions.py 100.00% <100.00%> (ø)
tests/test_tools.py 98.50% <100.00%> (-0.11%) ⬇️

yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
yucongalicechen
yucongalicechen commented Jan 23, 2025
View reviewed changes
tests/test_tools.py
),
(
{"username": "cli_username", "email": "cli@email.com", "orcid": "cli_orcid"},
{"username": "cli_username", "email": "cli@email.com", "orcid": "cli_orcid"},
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added tests for orcid

@yucongalicechen
Copy link
Collaborator Author

@sbillinge ready for review! this is probably a big commit.. But most changes are for updating docstrings and test comments.

@sbillinge
Copy link
Contributor

@yucongalicechen nicely done there!

@sbillinge sbillinge merged commit 8ef887c into diffpy:main Jan 25, 2025
5 checks passed
@yucongalicechen yucongalicechen deleted the docstring-tests branch January 26, 2025 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

fix: refine docstring and test annotation following new group standard feat: add load_user_info with options for orcid and skip_creation_config`

2 participants

@yucongalicechen @sbillinge